<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<html>
<head>
<!-- Copyright 1997 The Open Group, All Rights Reserved -->

<title>in_wchnstr</title>
</head><body bgcolor=white>
<center>
<font size=2>
The Single UNIX &reg; Specification, Version 2<br>
Copyright &copy; 1997 The Open Group

</font></center><hr size=2 noshade>
<h4><a name = "tag_002_001_466">&nbsp;</a>NAME</h4><blockquote>
in_wchnstr, in_wchstr, mvin_wchnstr, mvin_wchstr,
mvwin_wchnstr, mvwin_wchstr, win_wchnstr, win_wchstr
- extract an array of complex characters and renditions from a window
</blockquote><h4><a name = "tag_002_001_467">&nbsp;</a>SYNOPSIS</h4><blockquote>
<pre><code>

#include &lt;<a href="curses.h.html">curses.h</a>&gt;

int in_wchnstr(cchar_t *<i>wchstr</i>, int <i>n</i>);

int in_wchstr(cchar_t *<i>wchstr</i>);

int mvin_wchnstr(int <i>y</i>, int <i>x</i>, cchar_t *<i>wchstr</i>, int <i>n</i>);

int mvin_wchstr(int <i>y</i>, int <i>x</i>, cchar_t *<i>wchstr</i>);

int mvwin_wchnstr(WINDOW *<i>win</i>, int <i>y</i>, int <i>x</i>, cchar_t *<i>wchstr</i>, int <i>n</i>);

int mvwin_wchstr(WINDOW *<i>win</i>, int <i>y</i>, int <i>x</i>, cchar_t *<i>wchstr</i>);

int win_wchnstr(WINDOW *<i>win</i>, cchar_t *<i>wchstr</i>, int <i>n</i>);

int win_wchstr(WINDOW *<i>win</i>, cchar_t *<i>wchstr</i>);
</code>
</pre>
</blockquote><h4><a name = "tag_002_001_468">&nbsp;</a>DESCRIPTION</h4><blockquote>
These functions extract characters from the current or specified window,
starting at the current or specified position and ending at the end of the
line, and place them in the array pointed to by
<i>wchstr</i>.
<p>
The
<i>in_wchnstr()</i>,
<i>mvin_wchnstr()</i>,
<i>mvwin_wchnstr()</i>
and
<i>win_wchnstr()</i>
fill the array with at most <i>n</i> <b>cchar_t</b> elements.
</blockquote><h4><a name = "tag_002_001_469">&nbsp;</a>RETURN VALUE</h4><blockquote>
Upon successful completion, these functions return OK.
Otherwise, they return ERR.
</blockquote><h4><a name = "tag_002_001_470">&nbsp;</a>ERRORS</h4><blockquote>
No errors are defined.
</blockquote><h4><a name = "tag_002_001_471">&nbsp;</a>APPLICATION USAGE</h4><blockquote>
Reading a line that overflows the array pointed to by <i>wchstr</i> with
<i>in_wchstr()</i>,
<i>mvin_wchstr()</i>,
<i>mvwin_wchstr()</i>
or
<i>win_wchstr()</i>
causes undefined results.  The use of
<i>in_wchnstr()</i>,
<i>mvin_wchnstr()</i>,
<i>mvwin_wchnstr()</i>
or
<i>win_wchnstr()</i>,
respectively, is recommended.
</blockquote><h4><a name = "tag_002_001_472">&nbsp;</a>SEE ALSO</h4><blockquote>
<i><a href="in_wch.html">in_wch()</a></i>,
<i><a href="curses.h.html">&lt;curses.h&gt;</a></i>.
</blockquote><hr size=2 noshade>
<center><font size=2>
UNIX &reg; is a registered Trademark of The Open Group.<br>
Copyright &copy; 1997 The Open Group
<br> [ <a href="../index.html">Main Index</a> | <a href="../xshix.html">XSH</a> | <a href="../xcuix.html">XCU</a> | <a href="../xbdix.html">XBD</a> | <a href="../cursesix.html">XCURSES</a> | <a href="../xnsix.html">XNS</a> ]

</font></center><hr size=2 noshade>
</body></html>
